<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkHandleBox: GTK+ 3 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GTK+ 3 Reference Manual">
<link rel="up" href="MiscObjects.html" title="Miscellaneous">
<link rel="prev" href="GtkEventBox.html" title="GtkEventBox">
<link rel="next" href="GtkIMContextSimple.html" title="GtkIMContextSimple">
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GtkHandleBox.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GtkHandleBox.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#GtkHandleBox.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#GtkHandleBox.properties" class="shortcut">Properties</a></span><span id="nav_signals">  <span class="dim">|</span> 
                  <a href="#GtkHandleBox.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="MiscObjects.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GtkEventBox.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GtkIMContextSimple.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GtkHandleBox"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkHandleBox.top_of_page"></a>GtkHandleBox</span></h2>
<p>GtkHandleBox — a widget for detachable window portions</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GtkHandleBox.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkHandleBox.html#gtk-handle-box-new" title="gtk_handle_box_new ()">gtk_handle_box_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkHandleBox.html#gtk-handle-box-set-shadow-type" title="gtk_handle_box_set_shadow_type ()">gtk_handle_box_set_shadow_type</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkHandleBox.html#gtk-handle-box-set-handle-position" title="gtk_handle_box_set_handle_position ()">gtk_handle_box_set_handle_position</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkHandleBox.html#gtk-handle-box-set-snap-edge" title="gtk_handle_box_set_snap_edge ()">gtk_handle_box_set_snap_edge</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="gtk3-Standard-Enumerations.html#GtkPositionType" title="enum GtkPositionType"><span class="returnvalue">GtkPositionType</span></a>
</td>
<td class="function_name">
<a class="link" href="GtkHandleBox.html#gtk-handle-box-get-handle-position" title="gtk_handle_box_get_handle_position ()">gtk_handle_box_get_handle_position</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="gtk3-Standard-Enumerations.html#GtkShadowType" title="enum GtkShadowType"><span class="returnvalue">GtkShadowType</span></a>
</td>
<td class="function_name">
<a class="link" href="GtkHandleBox.html#gtk-handle-box-get-shadow-type" title="gtk_handle_box_get_shadow_type ()">gtk_handle_box_get_shadow_type</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="gtk3-Standard-Enumerations.html#GtkPositionType" title="enum GtkPositionType"><span class="returnvalue">GtkPositionType</span></a>
</td>
<td class="function_name">
<a class="link" href="GtkHandleBox.html#gtk-handle-box-get-snap-edge" title="gtk_handle_box_get_snap_edge ()">gtk_handle_box_get_snap_edge</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GtkHandleBox.html#gtk-handle-box-get-child-detached" title="gtk_handle_box_get_child_detached ()">gtk_handle_box_get_child_detached</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkHandleBox.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="GtkHandleBox.html#GtkHandleBox--child-detached" title="The “child-detached” property">child-detached</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><a class="link" href="gtk3-Standard-Enumerations.html#GtkPositionType" title="enum GtkPositionType"><span class="type">GtkPositionType</span></a></td>
<td class="property_name"><a class="link" href="GtkHandleBox.html#GtkHandleBox--handle-position" title="The “handle-position” property">handle-position</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a class="link" href="gtk3-Standard-Enumerations.html#GtkShadowType" title="enum GtkShadowType"><span class="type">GtkShadowType</span></a></td>
<td class="property_name"><a class="link" href="GtkHandleBox.html#GtkHandleBox--shadow-type" title="The “shadow-type” property">shadow-type</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a class="link" href="gtk3-Standard-Enumerations.html#GtkPositionType" title="enum GtkPositionType"><span class="type">GtkPositionType</span></a></td>
<td class="property_name"><a class="link" href="GtkHandleBox.html#GtkHandleBox--snap-edge" title="The “snap-edge” property">snap-edge</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="GtkHandleBox.html#GtkHandleBox--snap-edge-set" title="The “snap-edge-set” property">snap-edge-set</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkHandleBox.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signal_proto_type">
<col width="300px" class="signal_proto_name">
<col width="200px" class="signal_proto_flags">
</colgroup>
<tbody>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GtkHandleBox.html#GtkHandleBox-child-attached" title="The “child-attached” signal">child-attached</a></td>
<td class="signal_flags">Run First</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GtkHandleBox.html#GtkHandleBox-child-detached" title="The “child-detached” signal">child-detached</a></td>
<td class="signal_flags">Run First</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkHandleBox.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GtkHandleBox.html#GtkHandleBox-struct" title="struct GtkHandleBox">GtkHandleBox</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GtkHandleBox.html#GtkHandleBoxClass" title="struct GtkHandleBoxClass">GtkHandleBoxClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkHandleBox.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> GInitiallyUnowned
        <span class="lineart">╰──</span> <a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
            <span class="lineart">╰──</span> <a class="link" href="GtkContainer.html" title="GtkContainer">GtkContainer</a>
                <span class="lineart">╰──</span> <a class="link" href="GtkBin.html" title="GtkBin">GtkBin</a>
                    <span class="lineart">╰──</span> GtkHandleBox
</pre>
</div>
<div class="refsect1">
<a name="GtkHandleBox.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GtkHandleBox implements
 AtkImplementorIface and  <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a>.</p>
</div>
<div class="refsect1">
<a name="GtkHandleBox.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;gtk/gtk.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GtkHandleBox.description"></a><h2>Description</h2>
<p>The <a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a> widget allows a portion of a window to be "torn
off". It is a bin widget which displays its child and a handle that
the user can drag to tear off a separate window (the “float
window”) containing the child widget. A thin
“ghost” is drawn in the original location of the
handlebox. By dragging the separate window back to its original
location, it can be reattached.</p>
<p>When reattaching, the ghost and float window, must be aligned
along one of the edges, the “snap edge”.
This either can be specified by the application programmer
explicitly, or GTK+ will pick a reasonable default based
on the handle position.</p>
<p>To make detaching and reattaching the handlebox as minimally confusing
as possible to the user, it is important to set the snap edge so that
the snap edge does not move when the handlebox is deattached. For
instance, if the handlebox is packed at the bottom of a VBox, then
when the handlebox is detached, the bottom edge of the handlebox's
allocation will remain fixed as the height of the handlebox shrinks,
so the snap edge should be set to <a class="link" href="gtk3-Standard-Enumerations.html#GTK-POS-BOTTOM:CAPS"><code class="literal">GTK_POS_BOTTOM</code></a>.</p>
<div class="blockquote"><blockquote class="blockquote"><p><a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a> has been deprecated. It is very specialized, lacks features
to make it useful and most importantly does not fit well into modern
application design. Do not use it. There is no replacement.</p></blockquote></div>
</div>
<div class="refsect1">
<a name="GtkHandleBox.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gtk-handle-box-new"></a><h3>gtk_handle_box_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
gtk_handle_box_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="warning">
<p><code class="literal">gtk_handle_box_new</code> has been deprecated since version 3.4 and should not be used in newly-written code.</p>
<p><a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a> has been deprecated.</p>
</div>
<p>Create a new handle box.</p>
<div class="refsect3">
<a name="gtk-handle-box-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-handle-box-set-shadow-type"></a><h3>gtk_handle_box_set_shadow_type ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_handle_box_set_shadow_type (<em class="parameter"><code><a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a> *handle_box</code></em>,
                                <em class="parameter"><code><a class="link" href="gtk3-Standard-Enumerations.html#GtkShadowType" title="enum GtkShadowType"><span class="type">GtkShadowType</span></a> type</code></em>);</pre>
<div class="warning">
<p><code class="literal">gtk_handle_box_set_shadow_type</code> has been deprecated since version 3.4 and should not be used in newly-written code.</p>
<p><a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a> has been deprecated.</p>
</div>
<p>Sets the type of shadow to be drawn around the border
of the handle box.</p>
<div class="refsect3">
<a name="gtk-handle-box-set-shadow-type.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>handle_box</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type</p></td>
<td class="parameter_description"><p>the shadow type.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-handle-box-set-handle-position"></a><h3>gtk_handle_box_set_handle_position ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_handle_box_set_handle_position (<em class="parameter"><code><a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a> *handle_box</code></em>,
                                    <em class="parameter"><code><a class="link" href="gtk3-Standard-Enumerations.html#GtkPositionType" title="enum GtkPositionType"><span class="type">GtkPositionType</span></a> position</code></em>);</pre>
<div class="warning">
<p><code class="literal">gtk_handle_box_set_handle_position</code> has been deprecated since version 3.4 and should not be used in newly-written code.</p>
<p><a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a> has been deprecated.</p>
</div>
<p>Sets the side of the handlebox where the handle is drawn.</p>
<div class="refsect3">
<a name="gtk-handle-box-set-handle-position.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>handle_box</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>position</p></td>
<td class="parameter_description"><p>the side of the handlebox where the handle should be drawn.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-handle-box-set-snap-edge"></a><h3>gtk_handle_box_set_snap_edge ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_handle_box_set_snap_edge (<em class="parameter"><code><a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a> *handle_box</code></em>,
                              <em class="parameter"><code><a class="link" href="gtk3-Standard-Enumerations.html#GtkPositionType" title="enum GtkPositionType"><span class="type">GtkPositionType</span></a> edge</code></em>);</pre>
<div class="warning">
<p><code class="literal">gtk_handle_box_set_snap_edge</code> has been deprecated since version 3.4 and should not be used in newly-written code.</p>
<p><a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a> has been deprecated.</p>
</div>
<p>Sets the snap edge of a handlebox. The snap edge is
the edge of the detached child that must be aligned
with the corresponding edge of the “ghost” left
behind when the child was detached to reattach
the torn-off window. Usually, the snap edge should
be chosen so that it stays in the same place on
the screen when the handlebox is torn off.</p>
<p>If the snap edge is not set, then an appropriate value
will be guessed from the handle position. If the
handle position is <a class="link" href="gtk3-Standard-Enumerations.html#GTK-POS-RIGHT:CAPS"><code class="literal">GTK_POS_RIGHT</code></a> or <a class="link" href="gtk3-Standard-Enumerations.html#GTK-POS-LEFT:CAPS"><code class="literal">GTK_POS_LEFT</code></a>,
then the snap edge will be <a class="link" href="gtk3-Standard-Enumerations.html#GTK-POS-TOP:CAPS"><code class="literal">GTK_POS_TOP</code></a>, otherwise
it will be <a class="link" href="gtk3-Standard-Enumerations.html#GTK-POS-LEFT:CAPS"><code class="literal">GTK_POS_LEFT</code></a>.</p>
<div class="refsect3">
<a name="gtk-handle-box-set-snap-edge.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>handle_box</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>edge</p></td>
<td class="parameter_description"><p>the snap edge, or -1 to unset the value; in which
case GTK+ will try to guess an appropriate value
in the future.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-handle-box-get-handle-position"></a><h3>gtk_handle_box_get_handle_position ()</h3>
<pre class="programlisting"><a class="link" href="gtk3-Standard-Enumerations.html#GtkPositionType" title="enum GtkPositionType"><span class="returnvalue">GtkPositionType</span></a>
gtk_handle_box_get_handle_position (<em class="parameter"><code><a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a> *handle_box</code></em>);</pre>
<div class="warning">
<p><code class="literal">gtk_handle_box_get_handle_position</code> has been deprecated since version 3.4 and should not be used in newly-written code.</p>
<p><a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a> has been deprecated.</p>
</div>
<p>Gets the handle position of the handle box. See
<a class="link" href="GtkHandleBox.html#gtk-handle-box-set-handle-position" title="gtk_handle_box_set_handle_position ()"><code class="function">gtk_handle_box_set_handle_position()</code></a>.</p>
<div class="refsect3">
<a name="gtk-handle-box-get-handle-position.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>handle_box</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-handle-box-get-handle-position.returns"></a><h4>Returns</h4>
<p> the current handle position.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-handle-box-get-shadow-type"></a><h3>gtk_handle_box_get_shadow_type ()</h3>
<pre class="programlisting"><a class="link" href="gtk3-Standard-Enumerations.html#GtkShadowType" title="enum GtkShadowType"><span class="returnvalue">GtkShadowType</span></a>
gtk_handle_box_get_shadow_type (<em class="parameter"><code><a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a> *handle_box</code></em>);</pre>
<div class="warning">
<p><code class="literal">gtk_handle_box_get_shadow_type</code> has been deprecated since version 3.4 and should not be used in newly-written code.</p>
<p><a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a> has been deprecated.</p>
</div>
<p>Gets the type of shadow drawn around the handle box. See
<a class="link" href="GtkHandleBox.html#gtk-handle-box-set-shadow-type" title="gtk_handle_box_set_shadow_type ()"><code class="function">gtk_handle_box_set_shadow_type()</code></a>.</p>
<div class="refsect3">
<a name="gtk-handle-box-get-shadow-type.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>handle_box</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-handle-box-get-shadow-type.returns"></a><h4>Returns</h4>
<p> the type of shadow currently drawn around the handle box.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-handle-box-get-snap-edge"></a><h3>gtk_handle_box_get_snap_edge ()</h3>
<pre class="programlisting"><a class="link" href="gtk3-Standard-Enumerations.html#GtkPositionType" title="enum GtkPositionType"><span class="returnvalue">GtkPositionType</span></a>
gtk_handle_box_get_snap_edge (<em class="parameter"><code><a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a> *handle_box</code></em>);</pre>
<div class="warning">
<p><code class="literal">gtk_handle_box_get_snap_edge</code> has been deprecated since version 3.4 and should not be used in newly-written code.</p>
<p><a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a> has been deprecated.</p>
</div>
<p>Gets the edge used for determining reattachment of the handle box.
See <a class="link" href="GtkHandleBox.html#gtk-handle-box-set-snap-edge" title="gtk_handle_box_set_snap_edge ()"><code class="function">gtk_handle_box_set_snap_edge()</code></a>.</p>
<div class="refsect3">
<a name="gtk-handle-box-get-snap-edge.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>handle_box</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-handle-box-get-snap-edge.returns"></a><h4>Returns</h4>
<p> the edge used for determining reattachment, or
(GtkPositionType)-1 if this is determined (as per default)
from the handle position.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-handle-box-get-child-detached"></a><h3>gtk_handle_box_get_child_detached ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gtk_handle_box_get_child_detached (<em class="parameter"><code><a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a> *handle_box</code></em>);</pre>
<div class="warning">
<p><code class="literal">gtk_handle_box_get_child_detached</code> has been deprecated since version 3.4 and should not be used in newly-written code.</p>
<p><a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a> has been deprecated.</p>
</div>
<p>Whether the handlebox’s child is currently detached.</p>
<div class="refsect3">
<a name="gtk-handle-box-get-child-detached.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>handle_box</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-handle-box-get-child-detached.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the child is currently detached, otherwise <code class="literal">FALSE</code></p>
</div>
<p class="since">Since: 2.14</p>
</div>
</div>
<div class="refsect1">
<a name="GtkHandleBox.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkHandleBox-struct"></a><h3>struct GtkHandleBox</h3>
<pre class="programlisting">struct GtkHandleBox;</pre>
</div>
<hr>
<div class="refsect2">
<a name="GtkHandleBoxClass"></a><h3>struct GtkHandleBoxClass</h3>
<pre class="programlisting">struct GtkHandleBoxClass {
  GtkBinClass parent_class;

  void (*child_attached) (GtkHandleBox *handle_box,
				 GtkWidget *child);
  void (*child_detached) (GtkHandleBox *handle_box,
				 GtkWidget *child);
};
</pre>
<div class="refsect3">
<a name="GtkHandleBoxClass.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GtkHandleBoxClass.child-attached"></a>child_attached</code></em> ()</p></td>
<td class="struct_member_description"><p>Signal emitted when the contents of the handlebox
are reattached to the main window. Deprecated: 3.4.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GtkHandleBoxClass.child-detached"></a>child_detached</code></em> ()</p></td>
<td class="struct_member_description"><p>Signal emitted when the contents of the handlebox
are detached from the main window. Deprecated: 3.4.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GtkHandleBox.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GtkHandleBox--child-detached"></a><h3>The <code class="literal">“child-detached”</code> property</h3>
<pre class="programlisting">  “child-detached”           <span class="type">gboolean</span></pre>
<p>A boolean value indicating whether the handlebox's child is attached or detached.</p>
<p>Owner: GtkHandleBox</p>
<p>Flags: Read</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkHandleBox--handle-position"></a><h3>The <code class="literal">“handle-position”</code> property</h3>
<pre class="programlisting">  “handle-position”          <a class="link" href="gtk3-Standard-Enumerations.html#GtkPositionType" title="enum GtkPositionType"><span class="type">GtkPositionType</span></a></pre>
<p>Position of the handle relative to the child widget.</p>
<p>Owner: GtkHandleBox</p>
<p>Flags: Read / Write</p>
<p>Default value: GTK_POS_LEFT</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkHandleBox--shadow-type"></a><h3>The <code class="literal">“shadow-type”</code> property</h3>
<pre class="programlisting">  “shadow-type”              <a class="link" href="gtk3-Standard-Enumerations.html#GtkShadowType" title="enum GtkShadowType"><span class="type">GtkShadowType</span></a></pre>
<p>Appearance of the shadow that surrounds the container.</p>
<p>Owner: GtkHandleBox</p>
<p>Flags: Read / Write</p>
<p>Default value: GTK_SHADOW_OUT</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkHandleBox--snap-edge"></a><h3>The <code class="literal">“snap-edge”</code> property</h3>
<pre class="programlisting">  “snap-edge”                <a class="link" href="gtk3-Standard-Enumerations.html#GtkPositionType" title="enum GtkPositionType"><span class="type">GtkPositionType</span></a></pre>
<p>Side of the handlebox that's lined up with the docking point to dock the handlebox.</p>
<p>Owner: GtkHandleBox</p>
<p>Flags: Read / Write</p>
<p>Default value: GTK_POS_TOP</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkHandleBox--snap-edge-set"></a><h3>The <code class="literal">“snap-edge-set”</code> property</h3>
<pre class="programlisting">  “snap-edge-set”            <span class="type">gboolean</span></pre>
<p>Whether to use the value from the snap_edge property or a value derived from handle_position.</p>
<p>Owner: GtkHandleBox</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
</div>
<div class="refsect1">
<a name="GtkHandleBox.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GtkHandleBox-child-attached"></a><h3>The <code class="literal">“child-attached”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a> *handlebox,
               <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a>    *widget,
               <span class="type">gpointer</span>      user_data)</pre>
<p>This signal is emitted when the contents of the
handlebox are reattached to the main window.</p>
<div class="warning">
<p><code class="literal">GtkHandleBox::child-attached</code> has been deprecated since version 3.4 and should not be used in newly-written code.</p>
<p><a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a> has been deprecated.</p>
</div>
<div class="refsect3">
<a name="GtkHandleBox-child-attached.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>handlebox</p></td>
<td class="parameter_description"><p>the object which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>widget</p></td>
<td class="parameter_description"><p>the child widget of the handlebox.
(this argument provides no extra information
and is here only for backwards-compatibility)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run First</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkHandleBox-child-detached"></a><h3>The <code class="literal">“child-detached”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a> *handlebox,
               <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a>    *widget,
               <span class="type">gpointer</span>      user_data)</pre>
<p>This signal is emitted when the contents of the
handlebox are detached from the main window.</p>
<div class="warning">
<p><code class="literal">GtkHandleBox::child-detached</code> has been deprecated since version 3.4 and should not be used in newly-written code.</p>
<p><a class="link" href="GtkHandleBox.html" title="GtkHandleBox"><span class="type">GtkHandleBox</span></a> has been deprecated.</p>
</div>
<div class="refsect3">
<a name="GtkHandleBox-child-detached.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>handlebox</p></td>
<td class="parameter_description"><p>the object which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>widget</p></td>
<td class="parameter_description"><p>the child widget of the handlebox.
(this argument provides no extra information
and is here only for backwards-compatibility)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run First</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>